﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;

#region "Custom namespace declarations"
using Comkarl;
#endregion

namespace Comkarl.Architecture.Patterns.MVC.Entities
{
    /// <summary>
    /// An exception thrown when some logic looks for a one not found in its underlying data store.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the identifier's name.
    /// </typeparam>
    public sealed class EntityNotFoundException<TIdentifierName> : EntityException<TIdentifierName> where TIdentifierName : IEquatable<TIdentifierName>
    {
        /// <summary>
        /// Retrieves the identifier for the not found entity.
        /// </summary>
        private Identifier<TIdentifierName> providedIdentifier;

        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="providedIdentifier">
        /// The identifier for the not found entity.
        /// </param>
        /// <param name="innerException">
        /// An optional exception which can be set if some underlying exception has been thrown.
        /// </param>
        public EntityNotFoundException(Identifier<TIdentifierName> providedIdentifier, Exception innerException)
            : base("EntityNotFound", null, innerException)
        {
            this.providedIdentifier = providedIdentifier;
        }

        /// <summary>
        /// Hides the inherited CurrentEntity property because if an entity has not been found, then the reference is useless.
        /// </summary>
        new private string CurrentEntity;
    }
}
